package cn.trigram.validation.annotation;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import cn.trigram.date.DateUtil;
import cn.trigram.validation.annotation.validator.DateFormatForIntegerValidator;
import cn.trigram.validation.annotation.validator.DateFormatForLongValidator;
import cn.trigram.validation.annotation.validator.DateFormatForStringValidator;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;

/**
 * 字符日期时间格式校验。
 * 对String，Integer，Long日期含义的字段进行格式校验，默认格式是{@link DateUtil#GF_DEFAULT_SHORT}
 * <br/>
 * 内部通过 {@link java.time.format.DateTimeFormatter} 实现
 *
 * @version 1.0.0
 * @date 2022/08/04 09:11:06
 * @since 1.0.0
 */
@Target({FIELD, METHOD, PARAMETER, ANNOTATION_TYPE, TYPE_USE})
@Retention(RUNTIME)
@Constraint(validatedBy = {DateFormatForStringValidator.class, DateFormatForIntegerValidator.class, DateFormatForLongValidator.class})
@Documented
@Repeatable(DateFormatCheck.List.class)
public @interface DateFormatCheck {

    String message() default "{gf.util.validation.DateFormatCheck.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    String value() default DateUtil.GF_DEFAULT_SHORT;

    /**
     * 是否必要，也既是是否可以为null、""
     * <br/>
     * true：表示必须
     * <br/>
     * false：表示可为null、""
     * <br/>
     * 如果允许为null、"" ，那么null 和"" 为验证通过
     *
     * @return boolean
     */
    boolean required() default true;

    @Target({FIELD, METHOD, PARAMETER, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        DateFormatCheck[] value();
    }
}
